Obtener información de las bases de datos
La API de Datum te permite interactuar con bases de datos en Jelou, realizar consultas, y gestionar los datos de manera sencilla.
GET
https://api.jelou.ai/v2/databases
Parámetros de consulta
Propiedad | Tipo de dato | Descripción |
---|---|---|
shouldPaginate | String | Paginación de los resultados |
Respuestas:
- 200: OK - Respuesta exitosa.
- 401: Unauthorized - No autorizado.
- 500: Internal Server Error - Error en el servidor.
Ejemplo de respuesta:
{
"message": ["¡Bases de datos recuperadas exitosamente!"],
"statusMessage": "success",
"status": 1,
"data": [
{
"id": 123456789,
"name": "JELOU TEST",
"slug": "jeloutest",
"driver": "elastic",
"description": "JELOU TEST",
"companyId": 135,
"schema": {
"type": "object",
"properties": {
"total": { "type": "string", "database": "text" },
"name": { "type": "string", "database": "text" }
},
"required": ["total", "name"]
}
}
]
}
Estructura de la base de datos
Propiedad | Tipo | Descripción |
---|---|---|
id | String | ID de la base de datos. |
name | String | Nombre de la base de datos. |
description | String | Descripción de la base de datos. |
schema | Object | Esquema de la base de datos. Para más información, consulta la estructura del esquema. |
state | Boolean | Estado de la base de datos. True = Activa, False = Eliminada. |
createdAt | Date | Fecha de creación de la base de datos. |
updatedAt | Date | Fecha de actualización de la base de datos. |
columns | Array | Columnas de la base de datos. Información sobre el nombre, descripción y orden a presentar en Datum. |
metadata | Array | Metadatos de la base de datos. Metadatos a presentar en Datum. |
Estructura del esquema
Propiedad | Tipo de dato | Descripción |
---|---|---|
type | String | Tipo de dato de esquema |
required | Array | Array de Strings. Define los campos obligatorios para insertar un registro. |
properties | Objeto | Cada elemento es un campo en la base de datos. Dentro de cada campo, el 'type' define el Tipo de dato de dato del elemento. |
Obtener información de una base de datos específica
GET
https://api.jelou.ai/v2/databases/DATABASE_ID
Parámetros de ruta
Propiedad | Tipo de dato | Descripción |
---|---|---|
DATABASE_ID | String | ID de la base de datos |
Respuestas:
- 200: OK - Respuesta exitosa.
- 401: Unauthorized - No autorizado.
- 500: Internal Server Error - Error en el servidor.
- 404: Not Found - No encontrado.
Ejemplo de respuesta:
{
"message": ["¡Base de datos recuperada exitosamente!"],
"statusMessage": "success",
"status": 1,
"data": {
"id": 123456789,
"name": "JELOU TEST",
"slug": "jeloutest",
"schema": {
"type": "object",
"properties": {
"total": { "type": "string", "database": "text" },
"name": { "type": "string", "database": "text" }
},
"required": ["total", "name"]
}
}
}